/*
 * Copyright 2013 JROSE
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jrose.core.jdbc.entity;

import org.jrose.core.jdbc.entity.field.PersistenceField;
import org.jrose.core.jdbc.entity.field.internal.ColumnField;
import org.jrose.core.jdbc.entity.field.internal.CreateTimestampField;
import org.jrose.core.jdbc.entity.field.internal.PrimaryKeyField;
import org.jrose.core.jdbc.entity.field.internal.RevisionField;
import org.jrose.core.jdbc.entity.field.internal.UpdateTimestampField;

import java.io.Serializable;
import java.util.List;

/**
 * For providing definitions of specified entity.
 *
 * @author Xiaohai Zhang
 * @since 2013-08-22 10:12
 */
public interface EntityDefinition<E extends Serializable> {
    Class<E> getEntityClass();

    String getTableName();

    boolean hasPrimaryKey();

    List<PrimaryKeyField> getPrimaryKeyFields();

    List<CreateTimestampField> getCreateTimestampFields();

    List<UpdateTimestampField> getUpdateTimestampFields();

    List<RevisionField> getRevisionFields();

    List<ColumnField> getColumnFields();

    List<PersistenceField> getAllFields();

    PersistenceField getPersistenceField(String fieldName);

    PersistenceField getPersistenceFieldByColumn(String columnName);
}
